home *** CD-ROM | disk | FTP | other *** search
/ CICA 32 1998 April / CICA32 (April 1998) (Disc 4 of 4).iso / utils / unzip531.tgz / unzip531.tar / vms / unzip_cli.help < prev    next >
Text File  |  1997-03-09  |  11KB  |  400 lines
  1. .!
  2. .!  File:    UNZIP_CLI.HELP
  3. .!
  4. .!  Author:    Hunter Goatley
  5. .!
  6. .!  Date:    12 Jul 94 (orig. UNZIP.RNH, 23 Oct 91)
  7. .!
  8. .!  Description:
  9. .!
  10. .!    TPU-processable source file to produce VMS on-line help for
  11. .!    portable UnZip.  Adapted from UNZIP.RNH, originally based on
  12. .!    UNZIP.MAN (now UNZIP.DOC).
  13. .!
  14. .!    To build:
  15. .!        $ EDIT /TPU/NOSECTION/NODISPLAY/COMMAND=CVTHELP.TPU UNZIP_CLI.HELP
  16. .!        $ RUNOFF /OUT=UNZIP.HLP UNZIP_CLI.RNH
  17. .!        $ LIBR /HELP/INSERT libr UNZIP
  18. .!
  19. .!  Modification history:
  20. .!
  21. .!    02-001        Hunter Goatley        12-JUL-1994 16:59
  22. .!        Genesis.
  23. .!    02-002        Cave Newt        14-JUL-1994 11:36
  24. .!        Fixed /*TEXT options and added/removed various options.
  25. .!    02-003        Cave Newt        28-JUL-1994 08:54
  26. .!        Removed semicolons from comments and moved /ZIPINFO.
  27. .!    02-004        Christian Spieler    06-OCT-1995 02:02
  28. .!        Changed to conform to revised .CLD definition.
  29. .!    02-005        Christian Spieler    06-FEB-1996 02:20
  30. .!        Added description of /HELP qualifier.
  31. .!    02-006        Christian Spieler    12-MAY-1996 00:50
  32. .!        Some clarifications/cleanups.
  33. .!    02-007        Christian Spieler    04-MAR-1997 22:25
  34. .!        Added /[NO]CASE_INSENSITIVE to ZipInfo mode;
  35. .!        documented the new /PASSWORD="decryption_key" option.
  36. .!
  37. <INIT>
  38. <MAIN>
  39. UNZIP
  40.  
  41. UnZip is used to extract files compressed and packaged by Zip (see HELP ZIP
  42. for information on ZIP).
  43.  
  44. For a brief help on Zip and Unzip, run each without specifying any
  45. parameters on the command line (or apply the /HELP qualifier).
  46. To get a brief help sceen about the alternate UNIX style command interface,
  47. run each with the -h option applied.
  48.  
  49. UNZIP will list, test, or extract from a ZIP archive.  ZIP archives are commonly
  50. found on MS-DOS systems; a VMS version of ZIP can also be found here.
  51.  
  52. Archive member extraction is implied by the absence of the /SCREEN (-c),
  53. /PIPE (-p), /TEST (-t), /LIST (-l, -v) or /COMMENT (-z) qualifiers (options).
  54. All archive members are processed unless a filespec is provided to
  55. specify a subset of the archive members.
  56. <FORMAT>
  57. UNZIP zipfile [file[,...]] [/qualifiers]
  58.  
  59. .!
  60. <TOPIC>
  61. Parameters
  62.  
  63. <PARAMETER>
  64. zipfile
  65.  
  66. <PTEXT>
  67. File specification for the ZIP archive(s) with optional wildcards. UnZip will
  68. perform actions specified for every zipfile matching the specification.
  69. The default file specification is SYS$DISK:[].ZIP.
  70.  
  71. Note that self-extracting ZIP files are supported; just specify the .EXE
  72. suffix yourself.
  73. <TXETP>
  74.  
  75. <PARAMETER>
  76. file
  77.  
  78. <PTEXT>
  79. An optional comma-separated list of archive members to be processed;
  80. if no list is given, all archive members are processed.  Expressions
  81. may be used to match multiple members.  Expressions should be enclosed
  82. in double-quotes to prevent interpretation by DCL.  Multiple filenames
  83. should be separated by blanks.  Each file specification is similar to
  84. a Unix egrep expression and may contain:
  85.  
  86. <LITERAL>
  87. |*       matches a sequence of 0 or more characters
  88. |?       matches exactly 1 character
  89. |[...]   matches any single character found inside the brackets;
  90. |        ranges are specified by a beginning character,
  91. |        a hyphen, and an ending character.  If a '!' or '^'
  92. |        immediately follows the left bracket, then any character
  93. |        not in the given range is matched.
  94. <LARETIL>
  95. <TXETP>
  96.  
  97. <QUALIFIERS>
  98. <QUALIFIER>
  99. /ZIPINFO
  100.  
  101. /ZIPINFO
  102.  
  103. Displays information about the Zip archive and the files contained therein.
  104. This function used to be provided by a separate ZipInfo program.
  105.  
  106. The following qualifiers may be specified with /ZIPINFO:
  107.  
  108. <LITERAL>
  109. |  /SHORT                 Short UNIX "ls -l" format (default)
  110. |  /MEDIUM                Medium UNIX "ls -l" format
  111. |  /LONG                  Long UNIX "ls -l" format
  112. |  /VERBOSE               Verbose, multi-page format
  113. |  /ONE_LINE              Filenames only, one per line
  114. |  /HEADER                Print header lines
  115. |  /TOTALS                Print totals for files
  116. |  /TIMES                 Print file times in sortable decimal format
  117. |  /[NO]CASE_INSENSITIVE  Match filenames case-insensitively
  118. |  /[NO]PAGE              Page screen output through built-in "more"
  119. <LARETIL>
  120. <QUALIFIER>
  121. /BINARY
  122.  
  123. /BINARY[=KEYWORD]
  124. /NOBINARY (default)
  125.  
  126. Selects conversion to VMS "standard" binary file format, which is
  127. "fixed length 512 byte records, no record attributes".
  128. The optional keywords recognized are:
  129. <LITERAL>
  130. |  AUTO      Automatically extracts files marked as "binary" (rather than
  131. |            "text") in in standard VMS binary file format. (default)
  132. |  ALL       Extracts all files in standard VMS binary file format.
  133. |  NONE      Same as /NOBINARY.
  134. <LARETIL>
  135.  
  136. Note that a combination of /BINARY[=AUTO] and /TEXT[=AUTO] is allowed.
  137. (see /TEXT qualifier)
  138. <QUALIFIER>
  139. /BRIEF
  140.  
  141. /BRIEF (default)
  142.  
  143. When used with /LIST, specifies that a brief listing of the archive's
  144. contents is to be displayed.  A brief listing shows the length, date,
  145. time, and file name for the files in the archive.
  146. <QUALIFIER>
  147. /CASE_INSENSITIVE
  148.  
  149. /CASE_INSENSITIVE
  150. /NOCASE_INSENSITIVE (default)
  151.  
  152. Match filenames case-insensitively.  (Good default option under VMS.)
  153. <QUALIFIER>
  154. /COMMENT
  155.  
  156. /COMMENT
  157. /NOCOMMENT
  158.  
  159. Display the archive comment.
  160. <QUALIFIER>
  161. /DIRECTORY
  162.  
  163. /DIRECTORY=directory-spec
  164.  
  165. Specifies the output directory where all the extracted files are to be
  166. placed.
  167. <QUALIFIER>
  168. /EXCLUDE
  169.  
  170. /EXCLUDE=(file[,...])
  171.  
  172. A comma-separated list of files to exclude when extracting files.
  173. If multiple files are specified, the list should be included in
  174. parentheses.
  175.  
  176. <QUALIFIER>
  177. /FRESHEN
  178.  
  179. /FRESHEN
  180. /NOFRESHEN
  181.  
  182. Freshen existing files; replace if newer.  Does not cause any new files to
  183. be created.
  184. <QUALIFIER>
  185. /FULL
  186.  
  187. /FULL
  188.  
  189. When used with /LIST, specifies that a full listing of the archive's
  190. contents is to be displayed.  A full listing shows the length,
  191. compression method, compressed size, compression ratio, date,
  192. time, CRC value, and file name for the files in the archive.
  193. <QUALIFIER>
  194. /HELP
  195.  
  196. /HELP
  197.  
  198. Displays a one-page brief help screen and exits quietly.
  199. <QUALIFIER>
  200. /JUNK
  201.  
  202. /JUNK
  203. /NOJUNK (default)
  204.  
  205. Junk the stored paths (don't recreated the archive's directory
  206. structure.
  207. <QUALIFIER>
  208. /LIST
  209.  
  210. /LIST
  211.  
  212. List the contents of the archive.  /BRIEF and /FULL can be used to
  213. specify the amount of information displayed.  The default is /BRIEF.
  214. <QUALIFIER>
  215. /LOWERCASE
  216.  
  217. /LOWERCASE
  218. /NOLOWERCASE (default)
  219.  
  220. Convert filenames from all-uppercase operating systems to lowercase.  This
  221. option has no effect under VMS.
  222. <QUALIFIER>
  223. /OVERWRITE
  224.  
  225. /OVERWRITE
  226. /NOOVERWRITE
  227.  
  228. The qualifier /OVERWRITE forces overwriting of existing files when extracting.
  229. The negation /NOOVERWRITE results in never overwriting an existing file.
  230. The default action is to prompt for desired action when about to
  231. overwrite an existing file.
  232.  
  233. For VMS, "overwriting" results in the creation of a new version of the file,
  234. unless version numbers are stored in the archive and /VERSION is specified.
  235. <QUALIFIER>
  236. /PAGE
  237.  
  238. /PAGE
  239. /NOPAGE
  240.  
  241. Feed all screen output through the built-in "more" pager.
  242. <QUALIFIER>
  243. /PASSWORD
  244.  
  245. /PASSWORD=decryption-password
  246.  
  247. Specifies a decryption password and prevents UnZip from prompting for
  248. a password in case the specified decryption key was wrong. The supplied
  249. string must be enclosed in double-quotes whenever it contains lowercase
  250. or special characters.
  251. <QUALIFIER>
  252. /PIPE
  253.  
  254. /PIPE
  255.  
  256. Extract files to SYS$OUTPUT with no informational messages.
  257. <QUALIFIER>
  258. /QUIET
  259.  
  260. /QUIET[=SUPER]
  261.  
  262. Perform operations quietly.  The keyword SUPER can be specified to make
  263. operations even more quiet.
  264. <QUALIFIER>
  265. /RESTORE
  266.  
  267. /RESTORE
  268. /NORESTORE
  269.  
  270. Restore file owner and protection settings.
  271. <QUALIFIER>
  272. /SCREEN
  273.  
  274. /SCREEN
  275. /NOSCREEN
  276.  
  277. Extracts matching files to SYS$OUTPUT (the terminal).
  278. <QUALIFIER>
  279. /TEST
  280.  
  281. /TEST
  282. /NOTEST
  283.  
  284. Test archive files.
  285. <QUALIFIER>
  286. /TEXT
  287.  
  288. /TEXT[=KEYWORD]
  289. /NOTEXT (default)
  290.  
  291. Selects conversion to VMS standard text file format.
  292. The optional keywords recognized are:
  293. <LITERAL>
  294. |  AUTO      Automatically extracts files marked as "text" (rather than
  295.              "binary") in in standard VMS text file format. (default)
  296. |  ALL       Extracts all files in standard VMS text file format.
  297. |  NONE      Same as /NOTEXT.
  298. <LARETIL>
  299.  
  300. A similar functionality is available for binary files, see qualifier /BINARY.
  301. <QUALIFIER>
  302. /UPDATE
  303.  
  304. /UPDATE
  305. /NOUPDATE
  306.  
  307. Update existing files; create new ones if needed.
  308. <QUALIFIER>
  309. /VERSION
  310.  
  311. /VERSION
  312. /NOVERSION (default)
  313.  
  314. Retain VMS file version numbers.
  315.  
  316. <TOPIC>
  317. Authors
  318.  
  319. Info-ZIP; currently maintained by Greg Roelofs.  VMS support maintained
  320. by Igor Mandrichenko and Hunter Goatley.  Originally based on a program
  321. by Samuel H. Smith.
  322.  
  323. VMS on-line help ported from UNZIP.DOC by Hunter Goatley.
  324.  
  325. <TOPIC>
  326. UNIX_Options
  327.  
  328. The default action of UnZip is to extract all zipfile entries.  The following
  329. options and modifiers can be provided:
  330.  
  331. <LITERAL>
  332. |  -Z   ZipInfo mode
  333. |  -c   extract files to SYS$OUTPUT (terminal)
  334. |  -f   freshen existing files (replace if newer); create none
  335. |  -h   show brief help screen and exit quietly
  336. |  -l   list archive files (short format)
  337. |  -p   extract files to SYS$OUTPUT; no informational messages
  338. |  -t   test archive files
  339. |  -u   update existing files; create new ones if needed
  340. |  -v   list archive files (verbose format)
  341. |  -z   display only the archive comment
  342. |
  343. |MODIFIERS
  344. |  -a   auto-extract only text files in standard VMS text file format
  345. |  -aa  extract all files as text
  346. |  -b   auto-extract only binary files in VMS fixed 512 bytes records
  347. |  -bb  extract all files as binary VMS fixed 512 byte record files
  348. |  -j   junk paths (don't recreate archive's directory structure)
  349. |  -n   never overwrite existing files; don't prompt
  350. |  -o   OK to overwrite files without prompting
  351. |  -q   perform operations quietly (-qq => even quieter)
  352. |  -C   match filenames case-insensitively
  353. |  -L   convert filenames to lowercase if created on MSDOS, VMS, etc.
  354. |  -Ppassword  supply decryption password on the command line (insecure!)
  355. |  -M   page output through built-in "more" function
  356. |  -V   retain (VMS) file version numbers
  357. |  -X   restore owner/protection info (may require privileges)
  358. <LARETIL>
  359.  
  360. Note that uppercase options such as -C, -L, -M, -P, -V, -X and -Z must
  361. be specified in quotes.  For example:
  362.  
  363. <LITERAL>
  364. |  $ unzip "-VX" -a zipfile
  365. <LARETIL>
  366.  
  367. <TOPIC>
  368. UNZIP_OPTS_Default
  369.  
  370. UnZip allows to modify its default behaviour by specifying (UNIX style)
  371. option defaults via the UNZIP_OPTS logical name.
  372. For example, the following will cause UnZip to match filenames without regard
  373. to case, restore owner/protection information and perform all operations at
  374. quiet-level 1 by default:
  375.  
  376. <LITERAL>
  377. |  $ define UNZIP_OPTS "-qCX"
  378. <LARETIL>
  379.  
  380. Note that the quotation marks here are required to preserve lowercase options
  381. (opposite of the command-line behavior). To negate a default option on the
  382. command line, add one or more minus  signs before the option letter, in
  383. addition to the leading switch character `-':
  384.  
  385. <LITERAL>
  386. |  $ unzip --ql zipfile
  387. <LARETIL>
  388.  
  389. or
  390.  
  391. <LITERAL>
  392. |  $ unzip -l-q zipfile
  393. <LARETIL>
  394.  
  395. At present it is not possible to decrement an option below zero--that is,
  396. more than a few minuses have no effect.
  397.  
  398. UNZIP_OPTS may be defined as a symbol rather than a logical, but if both
  399. are defined, the logical is used.
  400.